/*
 * Package il.ac.biu.cs.grossmm.api.presence
 * File Pidf.java
 * 
 * This is a part of presence service framework API. 
 * See javadoc for more information.
 *  
 * Copyright (C) 2006 Grossmann Mark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package il.ac.biu.cs.grossmm.api.presence;

import static il.ac.biu.cs.grossmm.api.data.NodeTypeByInterface.*;
import il.ac.biu.cs.grossmm.api.data.NodeInterface;
import il.ac.biu.cs.grossmm.api.data.Nodeset;
import il.ac.biu.cs.grossmm.api.data.Property;

/**
 * Data node type interface which represents a PIDF document and defines a
 * minimal set of presence status values defined by the IMPP Model document.
 * <p>
 * PIDF is a common presence data format for CPP-compliant presence protocols,
 * allowing presence information to be transferred across CPP-compliant protocol
 * boundaries without modification, with attendant benefits for security and
 * performance.
 * <p>
 * This interface does not include any extensions to PIDF and should be used
 * only in cases when these extensions are not required. In order to preserve
 * all extensions to PIDF, <tt>XomPidf</tt> node type interface should be
 * used.
 */
public interface Pidf extends NodeInterface {
	/**
	 * The value of the 'entity' attribute, countains is the 'pres' URL of the
	 * PRESENTITY publishing this presence document.
	 */
	Property<Pidf, String> ENTITY = property(Pidf.class, String.class);

	/**
	 * Represents set of pidf tuples. Tuples provide a way of segmenting
	 * presence information.
	 */
	Nodeset<Pidf, PidfTuple> TUPLES = nodeset(Pidf.class, PidfTuple.class);

	/**
	 * Represents a 'note' element and contains a string value, which is usually
	 * used for a human readable comment.
	 */
	Nodeset<Pidf, PidfNote> NOTES = nodeset(Pidf.class, PidfNote.class);
}
